\hypertarget{gps__setup_8h}{\section{E\-:/\-C\-O\-D\-I\-N\-G/arduino-\/1.0/libraries/gps/gps\-\_\-setup.h File Reference}
\label{gps__setup_8h}\index{E\-:/\-C\-O\-D\-I\-N\-G/arduino-\/1.\-0/libraries/gps/gps\-\_\-setup.\-h@{E\-:/\-C\-O\-D\-I\-N\-G/arduino-\/1.\-0/libraries/gps/gps\-\_\-setup.\-h}}
}


S\-E\-T\-U\-P F\-I\-L\-E for the G\-P\-S utility library.  


\subsection*{Macros}
\begin{DoxyCompactItemize}
\item 
\#define \hyperlink{gps__setup_8h_a0e98ac52ba5f9f671a87ee47ca45ddf2}{P\-M\-T\-K\-C\-H\-N\-\_\-\-E\-N\-A\-B\-L\-E}
\begin{DoxyCompactList}\small\item\em Enable the \$\-P\-M\-T\-K\-C\-H\-N functionality. \end{DoxyCompactList}\item 
\#define \hyperlink{gps__setup_8h_af98456070a63f454dbd60f56a7907616}{T\-O\-T\-A\-L\-\_\-\-C\-H\-A\-N\-N\-E\-L}~(0)
\begin{DoxyCompactList}\small\item\em Override the total channel count. \end{DoxyCompactList}\item 
\#define \hyperlink{gps__setup_8h_a9af75e27cc4e0868f069f54834cc9540}{C\-H\-E\-C\-K\-S\-U\-M\-\_\-\-E\-N\-A\-B\-L\-E}
\begin{DoxyCompactList}\small\item\em Enable checksum functionality. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
S\-E\-T\-U\-P F\-I\-L\-E for the G\-P\-S utility library. This file is used to setup the gps utility librari. Simply remove or add the comment // to set your option. 

\subsection{Macro Definition Documentation}
\hypertarget{gps__setup_8h_a9af75e27cc4e0868f069f54834cc9540}{\index{gps\-\_\-setup.\-h@{gps\-\_\-setup.\-h}!C\-H\-E\-C\-K\-S\-U\-M\-\_\-\-E\-N\-A\-B\-L\-E@{C\-H\-E\-C\-K\-S\-U\-M\-\_\-\-E\-N\-A\-B\-L\-E}}
\index{C\-H\-E\-C\-K\-S\-U\-M\-\_\-\-E\-N\-A\-B\-L\-E@{C\-H\-E\-C\-K\-S\-U\-M\-\_\-\-E\-N\-A\-B\-L\-E}!gps_setup.h@{gps\-\_\-setup.\-h}}
\subsubsection[{C\-H\-E\-C\-K\-S\-U\-M\-\_\-\-E\-N\-A\-B\-L\-E}]{\setlength{\rightskip}{0pt plus 5cm}\#define C\-H\-E\-C\-K\-S\-U\-M\-\_\-\-E\-N\-A\-B\-L\-E}}\label{gps__setup_8h_a9af75e27cc4e0868f069f54834cc9540}


Enable checksum functionality. 

While higly recommended to be activated, you can comment this option to deactivate the checksum verification on N\-M\-E\-A string. When deactivated the library will still check the format of the N\-M\-E\-A string in this manner\-:
\begin{DoxyItemize}
\item string start with char \$
\item string contain char $\ast$ at \mbox{[}S\-T\-R\-I\-N\-G\-\_\-\-L\-E\-N\-G\-H\-T -\/ 5\mbox{]}
\item string finish with new line \par
 The only good reason to deactivate the checksum on N\-M\-E\-A string is to save memory on the device. 
\end{DoxyItemize}\hypertarget{gps__setup_8h_a0e98ac52ba5f9f671a87ee47ca45ddf2}{\index{gps\-\_\-setup.\-h@{gps\-\_\-setup.\-h}!P\-M\-T\-K\-C\-H\-N\-\_\-\-E\-N\-A\-B\-L\-E@{P\-M\-T\-K\-C\-H\-N\-\_\-\-E\-N\-A\-B\-L\-E}}
\index{P\-M\-T\-K\-C\-H\-N\-\_\-\-E\-N\-A\-B\-L\-E@{P\-M\-T\-K\-C\-H\-N\-\_\-\-E\-N\-A\-B\-L\-E}!gps_setup.h@{gps\-\_\-setup.\-h}}
\subsubsection[{P\-M\-T\-K\-C\-H\-N\-\_\-\-E\-N\-A\-B\-L\-E}]{\setlength{\rightskip}{0pt plus 5cm}\#define P\-M\-T\-K\-C\-H\-N\-\_\-\-E\-N\-A\-B\-L\-E}}\label{gps__setup_8h_a0e98ac52ba5f9f671a87ee47ca45ddf2}


Enable the \$\-P\-M\-T\-K\-C\-H\-N functionality. 

if P\-M\-T\-K\-C\-H\-N\-\_\-\-E\-N\-A\-B\-L\-E is defined, the librarie will decode the \$\-P\-M\-T\-K\-C\-H\-N message for the M\-T\-K gps channel information. The channel information is storred in the global 'channel\-\_\-s struct' 'chan' array. The 'channel\-\_\-s struct' contain\-:
\begin{DoxyItemize}
\item uint8\-\_\-t svid; // Space Vehicle Id
\item uint8\-\_\-t snr; // Signal to Noise Ratio
\item uint8\-\_\-t status; // 0\-: Idle / 1\-: Searching / 2\-: Tracking 
\end{DoxyItemize}\hypertarget{gps__setup_8h_af98456070a63f454dbd60f56a7907616}{\index{gps\-\_\-setup.\-h@{gps\-\_\-setup.\-h}!T\-O\-T\-A\-L\-\_\-\-C\-H\-A\-N\-N\-E\-L@{T\-O\-T\-A\-L\-\_\-\-C\-H\-A\-N\-N\-E\-L}}
\index{T\-O\-T\-A\-L\-\_\-\-C\-H\-A\-N\-N\-E\-L@{T\-O\-T\-A\-L\-\_\-\-C\-H\-A\-N\-N\-E\-L}!gps_setup.h@{gps\-\_\-setup.\-h}}
\subsubsection[{T\-O\-T\-A\-L\-\_\-\-C\-H\-A\-N\-N\-E\-L}]{\setlength{\rightskip}{0pt plus 5cm}\#define T\-O\-T\-A\-L\-\_\-\-C\-H\-A\-N\-N\-E\-L~(0)}}\label{gps__setup_8h_af98456070a63f454dbd60f56a7907616}


Override the total channel count. 

If T\-O\-T\-A\-L\-\_\-\-C\-H\-A\-N\-N\-E\-L is defined, the default total number of channel is overrided with the defined value. Only a positive integral value is valid. 0 or bellow 0 will be set as default value. 